Skip to content

docs: Phase AI CLI docs and updated Agent integration pages - #273

Open
nimish-ks wants to merge 2 commits into
mainfrom
docs/cli-agents
Open

nimish-ks wants to merge 2 commits into
mainfrom
docs/cli-agents

Conversation

@nimish-ks

Copy link
Copy Markdown
Member

Summary

Documents the CLI side of Agents. Console docs for Agents will follow separately, once the UI settles.

  • New CLI pages
    • Phase AI (/cli/ai): logging in with an Agent token or your own login, phase ai enable for each harness, how each harness uses Phase, status, run and exec, the process environment, supported services (AWS and PostgreSQL), requests and approvals, the proxy CA, disable, and the security model.
    • Phase AI relay (/cli/ai/relay): phase relay start, the sandbox bootstrap, and how relay sessions renew.
    • Phase AI control API (/cli/ai/control-api): the local phase.invalid API that Agents use behind the proxy. It sits in the CLI section, apart from the public API, and covers access, errors, every route, the request lifecycle, and headers on proxied traffic.
  • Commands reference: the ai section now covers the proxy commands, relay start is added, and token login mentions Agent tokens.
  • Agent Integration pages (Claude Code, Cursor, Codex, OpenCode, VS Code Copilot): rewritten for the two skills, phase-cli-ai-relay for Connections and phase-cli-app-secrets for app secrets. Examples that asked agents to run phase run, import .env files or read secret values are gone, because the new app-secrets skill forbids them.

Before merging

These pages describe the Agents release of the CLI (phasehq/cli#322), which isn't out yet. Merge this once that CLI release ships, or the live docs will describe commands users don't have.

Testing

… API

- Phase AI: Agent token login, phase ai enable per harness, status, run
  and exec, the process environment, supported services, requests, the
  proxy CA, disable and the security model.
- Phase AI relay: phase relay start, the sandbox bootstrap, and how
  sessions renew.
- Phase AI control API: the local phase.invalid routes, kept in the CLI
  section, apart from the public API.
- Commands: the ai section now covers the proxy commands, token login
  mentions Agent tokens, and relay start is added.
Each harness page now covers both skills: Connections through the Phase
AI proxy (what phase ai enable installs for that harness, how commands
use Phase, and the restart steps), and application secrets, which agents
manage without reading values. The examples no longer ask agents to run
phase run, import .env files, or read secret values, which the
phase-cli-app-secrets skill forbids.
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying phase-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: c8fc8bb
Status: ✅  Deploy successful!
Preview URL: https://2b5b9228.phase-docs.pages.dev
Branch Preview URL: https://docs-cli-agents.phase-docs.pages.dev

View logs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant